/*
 * ============================================================================
 *                   GNU Lesser General Public License
 * ============================================================================
 *
 *
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
 *
 *
 *
 */
package rad.framework.seam;

import java.io.OutputStream;
import java.util.List;

/**
 * The local interface for a Finder user interface.
 *
 * @author boudyacho
 * @generated
 */
public abstract interface AbstractFinder<E> {

	// ------------------------------------
	// lifecycle related
	// ------------------------------------

	void create();
	
	void destroy();

	// ------------------------------------
	// paging related
	// ------------------------------------

	Pager getPager();
	
    void pageChanged();

	// ------------------------------------
	// sorting related
	// ------------------------------------
    
    OrderBy getOrderBy();
    
    void orderChanged();
	
	// ------------------------------------
	// list related
	// ------------------------------------
    
	List<E> getResult();

	List<E> getReportResult();

    void updateResults();

	// ------------------------------------
	// filter related
	// ------------------------------------

	Filter getFilter();

	void filterSelected(Filter filter);

	void filterDeleted();
	
	String clearFilter();

	// ------------------------------------
	// navigation related
	// ------------------------------------

	String find();

	String quickAdd();

	String delete();

	String getEntityName();

	String getName();

	// ------------------------------------
	// render related
	// ------------------------------------

	boolean isRenderPrint();

	boolean isRenderPrintDetails();

	boolean isRenderCharts();

	boolean isRenderCreate();

	boolean isRenderQuickAdd();

	boolean isRenderAction();

	boolean isRenderView();

	boolean isRenderEdit();

	boolean isRenderDelete();

	boolean isRenderExcel();

	boolean isSimpleEntity();

	String getEditViewId();
	
	String getViewViewId();
	
	String getViewPath();

	List<ColumnType> getColumns();
	
	String getTitle();
	
	// ------------------------------------
	// Import/Export related
	// ------------------------------------

	boolean isRenderImport();

	boolean isRenderExport();

	void getExportXml(OutputStream os);
	
	void setImportData(byte[] importData);
	
	byte[] getImportData();
	
	String doImport();

	void importXml(String xml);
	
	// ------------------------------------
	// polling
	// ------------------------------------
	
	int getPollingInterval();

	boolean getPollingEnabled();
}
